chore(deps): update dependency @inquirer/prompts to v8 - #3454

v8.5.2

Compare Source

• Fix security warnings in external-editor

v8.5.1

Compare Source

• Rolled back mute-stream dependency from v4 to v3 to undo breaking compatible engines.
• Added tooling to prevent regression of the above in the future. This surfaced our min engines already enforced a higher limit, so adjusted the explicit limits to match the current state.

v8.5.0

Compare Source

• Feat: Read env variable INQUIRER_KEYBINDINGS to enable vim or emacs keybindings; making this a user preference instead of a library author preference. One caveat is doing so disable the search feature in the select prompt. Syntax: INQUIRER_KEYBINDINGS=vim,emacs.
• Fix: Line wraps would sometime cause the cursor to be mispositioned relative to the input.
• Chore: Bump dependencies.

v8.4.3

Compare Source

• Fix: Windows rendering bug
• Fix: Preserve exact literal types in choices array (Typescript only)
• Fix: Allow input default value to be of type undefined (Typescript only)
• Bump dependencies

v8.4.2

Compare Source

• Fix: some Windows terminals would freeze and not react to keypresses.

v8.4.1

Compare Source

• Improve expand prompt type inferrence.

v8.4.0

Compare Source

• Feat: Added a loading message while validating editor prompt input.
• Type improvement: Better type inference with checkbox, search and expand prompts.
• Fix: editor prompt not always properly handling editor path on windows.

v8.3.2

Compare Source

• Fix broken 8.3.1 release process.

v8.3.1

Compare Source

• Bump dependencies

v8.3.0

Compare Source

• Fix: Keypresses happening before a prompt is rendered are now ignored.
• Fix (checkbox): Element who're both checked and disabled are now always included in the returned array.
• Feat (select/checkbox): Cursor will now hover disabled options of the list; but they still cannot be interacted with. This prevents the cursor jumping ahead in ways that can be confusing.
• Feat: various new theme options to make all prompts content localizable.

Finally, see our new @inquirer/i18n package!

v8.2.1

Compare Source

• chore: Switch wrap-ansi with fast-wrap-ansi

v8.2.0

Compare Source

• feat(search): Add support for default.
• feat(rawlist): Add support for description of choices. That information is displayed under the list when the choice is highlighted.
• Bump dependencies

v8.1.0

Compare Source

• Feat: rawlist now supports default option.
• Fix: select now infer return type properly when passing a choices array of string literals.

v8.0.2

Compare Source

• Fix Typescript not discovering types when moduleResolution is set to commonjs (you probably want to fix that in your project if it's still in your tsconfig)

v8.0.1

Compare Source

v8.0.0

Compare Source

Release Notes

🚨 Breaking Changes

This is a major release that modernizes the codebase for Node.js ≥ 20.

ESM Only - No More CommonJS Support

Impact: All packages are now ESM-only. CommonJS imports are no longer supported.

If you're on modern Node versions (≥ 20), this should be transparent and have no impact.

Node.js Version Requirement

Minimum Node.js version is now 20.x

Node.js versions below 20 are no longer supported. Please upgrade to Node.js 20 or later.

Node min versions: >=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0

Deprecated APIs Removed

The following deprecated APIs have been removed after being deprecated in previous releases:

list prompt alias removed (affects inquirer package only)

The list alias has been removed from the inquirer package. This only impacts users of the legacy inquirer package, not users of @inquirer/prompts or individual prompt packages.

// ❌ No longer available (inquirer package only)
import inquirer from 'inquirer';
const answer = await inquirer.prompt([
  { type: 'list', name: 'choice', message: 'Pick one:', choices: ['a', 'b'] }
]);

// ✅ Use 'select' instead
import inquirer from 'inquirer';
const answer = await inquirer.prompt([
  { type: 'select', name: 'choice', message: 'Pick one:', choices: ['a', 'b'] }
]);

helpMode theme property removed

// ❌ No longer available
const answer = await select({
  theme: { helpMode: 'never' }
});

// ✅ Use theme.style.keysHelpTip instead
const answer = await select({
  theme: {
    style: {
      keysHelpTip: () => undefined // or your custom styling function
    }
  }
});

This affects the following prompts:

• @inquirer/checkbox
• @inquirer/search
• @inquirer/select

instructions config property removed

// ❌ No longer available
const answer = await checkbox({
  instructions: 'Custom instructions'
});

// ✅ Use theme.style.keysHelpTip instead
const answer = await checkbox({
  theme: {
    style: {
      keysHelpTip: (text) => 'Custom instructions'
    }
  }
});

This affects the following prompts:

• @inquirer/checkbox
• @inquirer/search
• @inquirer/select

cancel() method removed

The cancel() method on prompt return custom Promise has been removed.

// ❌ No longer available
const answerPromise = input({ message: 'Name?' });
answerPromise.cancel();
const answer = await answerPromise;

// ✅ Use AbortSignal instead
const controller = new AbortController();
const answer = await input(
  { message: 'Name?' },
  { signal: controller.signal }
);
controller.abort();

Color Library Change: yoctocolors → Node.js styleText

Internal change: The project now uses Node.js built-in util.styleText() instead of the yoctocolors package for terminal colors. This makes Inquirer smaller and reduces risks of vulnerabilities coming from transitive dependencies.

v7.10.1

Compare Source

• [Node 18 compat] Downgraded to mute-stream@​2 to maintain Node 18 compatibility.

v7.10.0

Compare Source

• feat @inquirer/input: Now support simple RegExp validation with pattern/patternError.
• fix @inquirer/editor: Fix typo s/waitForUseInput/waitForUserInput
• Bump dependencies

v7.9.0

Compare Source

• New design for the keys help tip. Themable/localizable with theme.style.keysHelpTip.
• Re-introduce option to match up/down actions with vim or emacs keybindings. Enable with theme.keybindings

v7.8.6

Compare Source

• Reduce number of transitive dependencies

v7.8.5

Compare Source

• Fix #​1834: (rawlist) Allows specifying numbers as explicit keys of option within the list.

v7.8.4

Compare Source

• fix: Remove "easter-egg" vim/emacs bindings conflicting with the type-to-search feature.

v7.8.3

Compare Source

• Fix Unix yes not properly being processed by the confirm prompt. (yes | node confirm-script.js)

v7.8.2

Compare Source

• Make @types/node an optional peer dependency.

v7.8.1

Compare Source

• Replace external-editor dependency with new @inquirer/external-editor. This remove the vulnerable tmp transitive dependency from the dependency tree.

v7.8.0

Compare Source

• Search prompt: New instructions config to allow localizing the help tips.

v7.7.1

Compare Source

• Fix #​1786 select prompt with indexMode: number theme option didn't properly calculate the items indexes if separators where present in between choices.

v7.7.0

Compare Source

• Select prompt: When pressing a number key, we'll ignore separators in counting the index of the item to jump to.
• Checkbox prompt: When pressing a number key, we'll ignore separators in counting the index of the item to select.

v7.6.0

Compare Source

-input prompt: New prefill option to control if the default value is editable inline or only after pressing tab.

v7.5.3

Compare Source

• Fix #​1743: pagination logic of the select, checkbox and search prompts was fully rewritten to handle edge cases around rendering multi-line choices and pointer positioning.

v7.5.2

Compare Source

• Chore: dependencies bump

v7.5.1

Compare Source

v7.5.0

Compare Source

• Feat(@​inquirer/select): Added an instructions option allowing to customize the messages in the help tips.
• Feat(@​inquirer/rawlist): Arrow keys will now cycle through the option, just like the @inquirer/select prompt. Also added a loop option to control the list loop behaviour when reaching the boundaries.

v7.4.1

Compare Source

• Fix number prompt (typescript): If prompt is required, only number can be returned. (previously was nullable)
• README: Add new sponsor
• Chore: dependency updates

v7.4.0

Compare Source

v7.3.3

Compare Source

• Fix an issue where inquirer would throw if Node is ran with the new --frozen-intrinsics flag.

This fix is also released through patches of all specific prompts packages.

v7.3.2

Compare Source

v7.3.1

Compare Source

• Mark @types/node as an optional peer dependency across all packages.

v7.3.0

Compare Source

v7.2.4

Compare Source